docs: rename quick-start to get-started and fix sidebar overflow#196
Open
giwaov wants to merge 2 commits into0xMiden:mainfrom
Open
docs: rename quick-start to get-started and fix sidebar overflow#196giwaov wants to merge 2 commits into0xMiden:mainfrom
giwaov wants to merge 2 commits into0xMiden:mainfrom
Conversation
Fixes 0xMiden#191 Renamed 'Quick Start' section to 'Get Started' to align with naming conventions used by other protocols (Aptos, Sui, Starknet). Changes: - Renamed docs/builder/quick-start/ to docs/builder/get-started/ - Renamed versioned_docs/version-0.13/builder/quick-start/ to get-started/ - Updated all _category_.json files with new labels and doc IDs - Updated sidebars.ts with new paths - Updated all internal links in: - docs/builder/index.md - docs/core-concepts/index.md - docs/builder/migration/index.md - docs/builder/tutorials/rust-compiler/*.md - static/llms.txt - CLAUDE.md - README.md - Added redirects in docusaurus.config.ts for: - /quick-start/* -> /builder/get-started/* - /builder/quick-start/* -> /builder/get-started/* v0.11 and v0.12 snapshots left unchanged (historical).
Fixes 0xMiden#170 Long titles in the smart-contracts section (e.g., 'Cross-Component Calls', 'Toolchain & Project Structure', 'Patterns & Security') were overflowing the sidebar container. Changes: - Added overflow-x: hidden to sidebar container and menu - Category labels now truncate with ellipsis (single line) - Leaf item links wrap naturally for better readability - Code elements in sidebar break-all to prevent overflow - Added word-wrap, overflow-wrap and hyphens for graceful text handling
b2ed5ec to
7032873
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses two documentation issues:
Issue #191: Rename quick-start to get-started
Renamed 'Quick Start' section to 'Get Started' to align with naming conventions used by other protocols (Aptos, Sui, Starknet).
Changes:
v0.11 and v0.12 snapshots left unchanged (historical).
Issue #170: Sidebar CSS overflow for long titles
Long titles in the smart-contracts section were overflowing the sidebar container.
Changes (src/custom/_sidebar.css):
Test Plan
pm run build\
Fixes #191
Fixes #170